BOT UX API

(0 reviews)

Get DetailedBalance

/{businessId}/detailedBalance

[GET]

This operation retrieves detailed balances by using subscriber number.

URL

http://[host]:[port]/bot-ux/v1/{businessId}/detailedBalance

URI Parameter

Note: CWC bu's is actual Implementation

Name	Type	M/O	Description
businessId	string	M	businessId string M Business unit identifier. Example: "JM",etc.,

Headers

name	value	description	required
X-Correlation-ID	string	This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b	M
lob	String	The Line of Business Identifier currently available are: Enum: PREPAID	M

Security Headers

Name	Type	M/O	Description
client_id	string	M	Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 438837c439924cbca0e96113d9abded0
client_secret	string	M	Client secret value for Client Id Enforcement policy. Environment Specific Value, eg: 8ABb78e206384B33aE08a61f5bDfd393

Query Param

Name	Type	M/O	Description
logicalResource.id	number	M	subscriberNumber/MSISDN

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

TMF Response for getDetailedBalances

Success Response

[
   {
        "name": "Core",
        "description": "primaryBalance",
        "isShared": true,
        "logicalResource": [
            {
                "@type": "subscriberNumber",
                "id": "18765544355"
            }
        ],
        "remainingValue": {
            "amount": 0.00,
            "units": "JMD"
        },
        "remainingValueName": "primaryBalance",
        "usageType": "Core",
        "validFor": {
            "endDateTime": "2023-02-11T00:00:00.000-05:00"
        },
        "status": "active",
        "@baseType": "BucketBalance",
        "@type": "B",
        "ratingState": "2",
        "@language": "ENG"
    },
    {
        "name": "internet",
        "description": "Mobile Internet",
        "isShared": true,
        "logicalResource": [
            {
                "@type": "subscriberNumber",
                "id": "18765544355"
            }
        ],
        "remainingValue": {
            "amount": 68.05,
            "units": "GB"
        },
        "remainingValueName": "Mobile Internet",
        "usageType": "Internet",
        "validFor": {
            "endDateTime": "2023-02-11T00:00:00.000-05:00"
        },
        "status": "active",
        "@baseType": "BucketBalance",
        "@type": "B",
        "ratingState": "2",
        "@language": "ENG"
    }
]